MarkLogic 12 Product Documentation

GET /manage/v2/groups/{id|name}?view=status

Summary

This resource address returns status information on the specified group. The group can be identified either by id or name.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data.

Required Privileges

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

id

A group unique id (64-bit value).

name

The name of a group of servers.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

status-properties

The summary of operating characteristics of hosts in the group.

This is a complex structure with the following children:

hosts-status-summary

This is a complex structure with the following children:

total-hosts

The total number of hosts.

total-hosts-offline

The total number of hosts offline.

total-cpu-stat-system

Total cpu utilization for system.

total-cpu-stat-user

Total cpu utilization for user.

memory-process-rss

The number of MB of Process Resident Size (RSS) for the MarkLogic process.

memory-size

The number of MB of virtual memory.

memory-system-total

The total system memory in MB. MemTotal from /proc/meminfo on Linux, ullTotalPhys from GlobalMemoryStatusEx on Windows.

memory-process-huge-pages-size

The size of huge pages for the MarkLogic process in MB. Available on Linux platform. Sum of Sizes after /anon_hugepage in /proc/[MLpid]/smaps

memory-system-free

The free system memory in MB. MemFree from /proc/meminfo on Linux, ullAvailPhys from GlobalMemoryStatusEx on Windows.

load-properties

The summary of load properties of hosts in the group.

This is a complex structure with the following children:

total-load

The sum of the processing load factors in seconds per second.

load-detail

The detailed load characteristics for hosts in the group.

This is a complex structure with the following children:

query-read-load

Disk reading time threads spent for a query in proportion to the elapsed time. This is summed for all of the contributing threads.

journal-write-load

Journal writing time threads spent in proportion to the elapsed time. This is summed for all of the threads writing on the host.

save-write-load

Time spent writing to in-memory stands, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

merge-read-load

Disk read time threads spent during merge, in proportion to the elapsed time. This is summed for all of the contributing threads.

merge-write-load

Disk writing time threads spent for merges, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

backup-read-load

Disk read time threads spent for backup, in proportion to the elapsed time. This is summed for all of the contributing threads.

backup-write-load

Disk writing time threads spent for backups, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

restore-read-load

Disk read time threads spent for restores, in proportion to the elapsed time. This is summed for all of the contributing threads.

restore-write-load

Disk write time threads spent for restores, in proportion to the elasped time. This is summed for all of the threads writing on the host.

large-read-load

Disk read time threads spent on large documents, in proportion to the elapsed time.

large-write-load

Disk write time threads spent for large documents, in proportion to the elapsed time.

external-binary-read-load

Disk read time threads spent on external binary documents, in proportion to the elapsed time.

xdqp-client-receive-load

Time threads spent receiving data for the xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-client-send-load

Time threads spent sending data for xdqp clients, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-receive-load

Time threads spent receiving data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

xdqp-server-send-load

Time threads spent sending data for the xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-client-receive-load

Time threads spent receiving data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-client-send-load

Time threads spent sending data for the foreign xdqp client, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-receive-load

Time threads spent receiving data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

foreign-xdqp-server-send-load

Time threads spent sending data for the foreign xdqp server, in proportion to the elapsed time. This is summed for all of the contributing threads.

read-lock-wait-load

Time threads spent waiting for read locks in proportion to the elapsed time, summed across all forests on the host.

read-lock-hold-load

Time threads spent holding read locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-wait-load

Time threads spent waiting to acquire write locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-hold-load

Time threads spent holding write locks in proportion to the elapsed time, summed across all forests on the host.

deadlock-wait-load

Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elapsed time, summed across all forests on the host.

rate-properties

The summary of rate properties of the hosts in the group.

This is a complex structure with the following children:

total-rate

The sum of the processing rate factors in seconds per second.

rate-detail

The detailed rate characteristics for the hosts in the group.

This is a complex structure with the following children:

memory-process-swap-rate

The swap rate for the MarkLogic process in pages/sec.

memory-system-pagein-rate

The page in rate for the system in pages/sec.

memory-system-pageout-rate

The page out rate for the system in pages/sec.

memory-system-swapin-rate

The swap in rate for the system in pages/sec.

memory-system-swapout-rate

The swap out rate for the system in pages/sec.

query-read-rate

The moving average throughput of reading query data from disk, in megabytes per second.

journal-write-rate

The moving average throughput of writing data to the journal, in megabytes per second.

save-write-rate

The moving average throughput of writing data to in-memory stands, in megabytes per second.

merge-read-rate

The moving average throughput of reading merge data from disk, in megabytes per second.

merge-write-rate

The moving average throughput of writing data for merges, in megabytes per second.

backup-read-rate

The moving average throughput of reading backup data from disk, in megabytes per second.

backup-write-rate

The moving average throughput of writing data for backups, in megabytes per second.

restore-read-rate

The moving average of disk read throughput for restores, in megabytes per second.

restore-write-rate

Disk write throughput for restore, in megabytes per second.

large-read-rate

The moving average throughput of reading large documents from disk, in megabytes per second.

large-write-rate

Disk write throughput of large documents, in megabytes per second.

external-binary-read-rate

Disk read throughput of external binary documents, in megabytes per second.

xdqp-client-receive-rate

The moving average throughput of the XDQP client receiving data, in megabytes per second.

xdqp-client-send-rate

The moving average throughput of the xdqp clients sending data, in megabytes per second.

xdqp-server-receive-rate

The moving average throughput of the xdqp server receiving data, in megabytes per second.

xdqp-server-send-rate

The moving average throughput of the xdqp server sending data, in megabytes per second.

foreign-xdqp-client-receive-rate

The moving average throughput of the foreign xdqp client receiving data, in megabytes per second.

foreign-xdqp-client-send-rate

The moving average throughput of the foreign xdqp client sending data, in megabytes per second.

foreign-xdqp-server-receive-rate

The moving average throughput of the foreign xdqp server receiving data, in megabytes per second.

foreign-xdqp-server-send-rate

The moving average throughput of the foreign xdqp server sending data, in megabytes per second.

read-lock-rate

The rate of read lock acquisitions, summed across all forests on the host.

write-lock-rate

The rate of write lock acquisitions, summed across all forests on the host.

deadlock-rate

The rate of deadlock occurrances, summed across all forests on the host.

servers-status-summary

The status summary for servers in the group.

This is a complex structure with the following children:

request-rate

The rate of a request (requests/sec).

expanded-tree-cache-miss-rate

The average number of misses on the expanded cache.

expanded-tree-cache-hit-rate

The average number of hits on the expanded cache.

request-count

The total number of requests for the servers of the group.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/groups/Default?view=status

==> Returns status information on the Default group.